/**
 * \file math.hpp
 * 
 * \section COPYRIGHT
 *
 * Basis: A 3D Mathematics Library
 *
 * ---------------------------------------------------------------------
 *
 * Copyright (c) 2010, Don Olmstead
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *  3. Neither the name of organization nor the names of its contributors may be
 *     used to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BASIS_MATH_HPP_INCLUDED
#define BASIS_MATH_HPP_INCLUDED

#include <basis/constants.hpp>

namespace basis
{
	/**
	 * Provides methods for trigonometric, logarithmic, and other common mathematical functions.
	 *
	 * \tparam Real A real number type.
	 *
	 * \author Don Olmstead
	 * \version 0.1
	 */
	template <typename Real>
	class math
	{

		//------------------------------------------------------------
		// Trigonometric methods
		//------------------------------------------------------------

		public:


		//------------------------------------------------------------
		// Power methods
		//------------------------------------------------------------

		public:

			/**
			 * Determines a specified number raised to a specified power.
			 *
			 * \param base A number to be raised to a power.
			 * \param exponent A number that specifies a power.
			 * \returns The number raised to a power.
			 */
			static inline Real pow(Real base, Real exponent)
			{
				return std::pow(base, exponent);
			}

			/**
			 * Determines the square of a number.
			 *
			 * \param value The number to square.
			 * \returns The square of the number.
			 */
			static inline Real sqr(Real value)
			{
				return value * value;
			}

			/**
			 * Determines the square root of a number.
			 *
			 * \param value The number to take the square root of.
			 * \returns The square root of the number.
			 */
			static inline Real sqrt(Real value)
			{
				return std::sqrt(value);
			}

		//------------------------------------------------------------
		// Rounding, absolute value and remainder methods
		//------------------------------------------------------------

		public:

			/**
			 * Determines the absolute value of a number.
			 *
			 * \param value The number to take the absolute value of.
			 * \returns The absolute value of the number.
			 */
			static inline Real abs(Real value)
			{
				return std::fabs(value);
			}

		//------------------------------------------------------------
		// Radian/Degrees conversions
		//------------------------------------------------------------

		public:

			/**
			 * Converts radians to degrees.
			 *
			 * \param radians The angle in radians.
			 * \returns The angle in degrees.
			 */
			static inline Real to_degrees(Real radians)
			{
				return constants<Real>::degrees_per_radian() * radians;
			}

			/**
			 * Converts degrees to radians.
			 *
			 * \param degrees The angle in degrees.
			 * \returns The angle in radians.
			 */
			static inline Real to_radians(Real degrees)
			{
				return constants<Real>::radians_per_degree() * degrees;
			}

		private:

			/**
			 * Default constructor.
			 *
			 * Private to disallow creation of instances.
			 */
			math() { }

	} ; // end class math

} // end namespace basis

#endif // end BASIS_MATH_HPP_INCLUDED
